home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1995 #5 & #6 / Amiga Plus CD - 1995 - No. 5 and 6.iso / pd / daten / ispell / doc / amigaarexx.doc < prev    next >
Text File  |  1995-07-03  |  5KB  |  126 lines
  1. =============================================================================
  2. Most of this document is an excerpt from Loren J. Rittle's README for the
  3. 3.3ljr Ispell archive (the file has been renamed to "LJR.README").
  4. =============================================================================
  5.  
  6. Overview of the ARexx Server Mode of ISpell
  7.  
  8. By no surprise, currently under the AmigaOS client-server relations are
  9. most easily implemented with ARexx.  Requests and replies take the form of
  10. ARexx messages.  The only limitation of using ARexx in order to implement
  11. client-server relations is that the client and the server must run on the
  12. same Amiga.  Hopefully, this restriction will be lifted with the advent of
  13. support on the Amiga for real networking protocols (TCP/IP and others).
  14.  
  15. ISpell can be started up in server mode with the following command:
  16.  
  17.     run <nil: >nil: ispell -r <nil: >nil:
  18.  
  19. Once the server has been started, it is a good idea to wait for the ISpell
  20. ARexx port to show up before trying to use it.  The ISpell's ARexx port
  21. name is IRexxSpell and the easiest way to wait for it's arrival is with the
  22. following command,
  23.  
  24.     waitforport 'IRexxSpell'
  25.  
  26. For thoses of you who are excited to see the ISpell ARexx server work type,
  27.  
  28.     rx "options results;address 'IRexxSpell' check ites;say result"
  29.  
  30. at a Shell prompt.
  31.  
  32. You should see the computer respond with,
  33.  
  34.     & BITES CITES ICES IRES ITEM ITEMS ITS KITES RITES SITES TIES
  35.  
  36. Or, if you have installed the ARexx front-end scripts into your REXX:
  37. directory then try typing,
  38.  
  39.     spell ites
  40.  
  41. The computer should respond with,
  42.  
  43.     The word 'ites' is not found. Try these words: bites cites ices 
  44.     ires item items its kites rites sites ties
  45.  
  46. Please see the README's interfaces/ directory tree for other interfaces
  47. available.
  48.  
  49. Feel free to write your own front-ends or modify the ones that I have
  50. supplied.  Below are the ARexx commands that ISpell knows how to respond
  51. to.  See my examples in the rexx directory for exact usage.  Have fun and
  52. please give the improved or new front-ends to ISpell away for all to see
  53. and play with.
  54.  
  55.  
  56.      Commands that the ISpell Server Will Respond To
  57.  
  58. ADD <word>         ---  Adds a word to the `global personal dictionary'
  59.               and immediately save the personal dictionary
  60.               to disk.
  61.  
  62. QUICKADD <word>      ---  Adds a word as above, without saving changes
  63.               to the file on disk.  An ADD command will
  64.               record any QUICKADD's since the last ADD.
  65.               If the server is shut down (or the Amiga's
  66.               power is lost), then all QUICKADD'ed words
  67.               are lost if no ADD was performed.
  68.  
  69. ACCEPT <word>         ---  Accept word for the rest of this Ispell session.
  70.               The word is *not* added to the dictionary!
  71.  
  72. CHECK <word>         ---  The ISpell server checks the stated word in its
  73.               dictionary and returns a string that describes
  74.               if the word was found or, if not, replacements.
  75.               This return string is documented in man/ispell.1,
  76.               it is the same as if words were piped in via
  77.               standard in. See rexx/spell.rexx and
  78.               rexx/ced/WordSpell.ced for how to parse the
  79.               returned string in ARexx.
  80.  
  81. Excerpt taken from man/ispell.1:
  82. If the word was found in the main dictionary, or your personal dictionary,
  83. then the line contains only a '*'.  If the word was found through suffix
  84. removal, then the line contains a '+', a space, and the root word.  If the
  85. word is not in the dictionary, but there are near misses, then the line
  86. contains an '&', a space, and a list of the near misses separated by
  87. spaces.
  88.  
  89. Also, each near miss is capitalized the same as the input word if unless
  90. such capitalization is illegal; in the latter case each near miss is
  91. capitalized correctly according to the dictionary.  Finally, if the word
  92. neither appears in the dictionary, and there are no near misses, then the
  93. line contains only a '#'.  This mode is also suitable for interactive use
  94. when you want to figure out the spelling of a single word.
  95.  
  96. QUICKCHECK <word>    ---  As above, but only checks to see if the
  97.               word is in the dictionary.  Does not try
  98.               to find close matches, etc.  See
  99.               rexx/ced/QuickWordSpell.ced for Usage.
  100.               Will return the string 'ok' or 'bad'
  101.               depending on if the word is found or not.
  102.  
  103. LOOKUP <word>         ---  Looks up word (really a grep pattern).
  104.               See rexx/lookup.rexx for usage.  `.*' is
  105.               the match anything wild-card :-). `.' is
  106.               the match one character wild-card, see a
  107.               manual on grep or src/regex.c for more
  108.               information.
  109.  
  110. FILECHECK <filename> ---  The ISpell server checks the named file, returns
  111.               the filename of a temporary file that contains
  112.               a list of words not found in the dictionary.
  113.               The client is required to delete the temporary
  114.               file when done with it.  Be sure to include the
  115.               complete path in the filename as there are no
  116.               good ways to know the current directory of the
  117.               ISpell server.  See rexx/spellfile.rexx and
  118.               rexx/ced/Spell.ced for usage.
  119.  
  120. VERSION             ---  The ISpell server replies with its version string
  121.               and a line of the currently compiled in ARexx
  122.               commands that it will response to.
  123.  
  124. EXIT             ---  Causes the ISpell server to terminate after
  125.               replying to the request.
  126.